Foxit PDF SDK
FoxitPDFSDKPython2.TagTreeItemData Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions

def TagTreeItemData ()
 Constructor.
More...
 
def Set (item_name, item_id, item_pos, item_rects, page_index, item_image_type, item_node_type)
 Set value.
More...
 

Static Public Attributes

 e_TagImageTypePageObject = _fsdk.TagTreeItemData_e_TagImageTypePageObject
 Tag image type : page object.

 
 e_TagImageTypePDF = _fsdk.TagTreeItemData_e_TagImageTypePDF
 Tag image type : PDF.

 
 e_TagImageTypeTable = _fsdk.TagTreeItemData_e_TagImageTypeTable
 Tag image type : table.

 
 e_TagImageTypeTableDataCell = _fsdk.TagTreeItemData_e_TagImageTypeTableDataCell
 Tag image type : table data cell.

 
 e_TagImageTypeTableHeaderCell = _fsdk.TagTreeItemData_e_TagImageTypeTableHeaderCell
 Tag image type : table header cell.

 
 e_TagImageTypeTableRow = _fsdk.TagTreeItemData_e_TagImageTypeTableRow
 Tag image type : table row.

 
 e_TagImageTypeTagNode = _fsdk.TagTreeItemData_e_TagImageTypeTagNode
 Tag image type : tag node.

 
 e_TagImageTypeTagParagraph = _fsdk.TagTreeItemData_e_TagImageTypeTagParagraph
 Tag image type : tag paragraph.

 
 e_TagImageTypeTagSection = _fsdk.TagTreeItemData_e_TagImageTypeTagSection
 Tag image type : tag section.

 
 e_TagNodeTypeElement = _fsdk.TagTreeItemData_e_TagNodeTypeElement
 Tag node type : element.

 
 e_TagNodeTypeMarkedContentSeq = _fsdk.TagTreeItemData_e_TagNodeTypeMarkedContentSeq
 Tag node type : marked content sequence.

 
 e_TagNodeTypeObject = _fsdk.TagTreeItemData_e_TagNodeTypeObject
 Tag node type : object.

 
 item_id = _fsdk.TagTreeItemData_item_id
 The unique identifier of the tag tree item.

 
 item_image_type = _fsdk.TagTreeItemData_item_image_type
 The image type used to represent this tag tree item. Please refer to values starting from FoxitPDFSDKPython2.TagTreeItemData.e_TagImageTypePDF .

 
 item_name = _fsdk.TagTreeItemData_item_name
 The display name of the tag tree item.

 
 item_node_type = _fsdk.TagTreeItemData_item_node_type
 The node type of this tag tree item. Please refer to values starting from FoxitPDFSDKPython2.TagTreeItemData.e_TagNodeTypeElement .

 
 item_pos = _fsdk.TagTreeItemData_item_pos
 The position descriptor of the tag tree item.

 
 item_rects = _fsdk.TagTreeItemData_item_rects
 The rectangles associated with this tag tree item.

 
 page_index = _fsdk.TagTreeItemData_page_index
 The page index where this tag tree item is located. Valid range: from 0 to (count-1), where count is returned by function FoxitPDFSDKPython2.PDFDoc.GetPageCount .

 

Detailed Description

This class represents accessibility tag tree item data.

Constructor & Destructor Documentation

◆ TagTreeItemData()

def FoxitPDFSDKPython2.TagTreeItemData.TagTreeItemData ( )

Constructor.

Constructor, with parameters.

Constructor, with another accessibility tag tree item data object.

Parameters
[in]otherAnother accessibility tag tree item data object whose values are copied to initialize the current object.
[in]item_nameThe display name of the tag tree item.
[in]item_idThe unique identifier of the tag tree item.
[in]item_posThe position descriptor of the tag tree item.
[in]item_rectsThe rectangles associated with this tag tree item.
[in]page_indexThe page index where this tag tree item is located. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython2.PDFDoc.GetPageCount .
[in]item_image_typeThe image type used to represent this tag tree item.
[in]item_node_typeThe node type of this tag tree item.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython2.TagTreeItemData.Set (   item_name,
  item_id,
  item_pos,
  item_rects,
  page_index,
  item_image_type,
  item_node_type 
)

Set value.

Parameters
[in]item_nameThe display name of the tag tree item.
[in]item_idThe unique identifier of the tag tree item.
[in]item_posThe position descriptor of the tag tree item.
[in]item_rectsThe rectangles associated with this tag tree item.
[in]page_indexThe page index where this tag tree item is located. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython2.PDFDoc.GetPageCount .
[in]item_image_typeThe image type used to represent this tag tree item.
[in]item_node_typeThe node type of this tag tree item.
Returns
None.